[VertexAI] Refactor the LiveSession responses #1231
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @a-maurice, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request refactors the handling of LiveSession responses in the VertexAI API. The primary change involves renaming the top-level struct from LiveContentResponse to LiveSessionResponse and reorganizing its fields into new structs that implement a shared interface, ILiveSessionMessage. This interface is implemented by LiveSessionContent, LiveSessionToolCall, and LiveSessionToolCallCancellation, each representing different types of messages from the live session. Additionally, the PR introduces helper methods for parsing lists of strings from JSON dictionaries.
Highlights
- Response Refactor: The top-level struct
LiveContentResponseis renamed toLiveSessionResponse, and its fields are moved into new structs (LiveSessionContent,LiveSessionToolCall,LiveSessionToolCallCancellation) that implement theILiveSessionMessageinterface. - New String List Parsing Methods: The
InternalHelpers.csfile is updated to include helper methods (TryParseStringListandParseStringList) for parsing lists of strings from JSON dictionaries. - ReceiveAsync Update: The
ReceiveAsyncmethod inLiveSession.csis updated to return anIAsyncEnumerable<LiveSessionResponse>instead ofIAsyncEnumerable<LiveContentResponse>, and the logic for determining turn completion is updated to check theTurnCompleteproperty of theLiveSessionContentmessage.
Changelog
Click here to see the changelog
- vertexai/src/Internal/InternalHelpers.cs
- Added
TryParseStringListmethod to safely attempt converting a list of objects to a list of strings. - Added
ParseStringListmethod to cast a list to a string list, throwing an exception if the cast fails.
- Added
- vertexai/src/LiveContentResponse.cs
- This entire file was removed as part of the refactoring.
- vertexai/src/LiveSession.cs
- Updated the
ReceiveAsyncmethod to returnIAsyncEnumerable<LiveSessionResponse>instead ofIAsyncEnumerable<LiveContentResponse>. - Modified the
ReceiveAsyncmethod to checkresponse?.Message is LiveSessionContent serverContent && serverContent.TurnCompletefor turn completion.
- Updated the
- vertexai/src/LiveSessionResponse.cs
- Created a new
LiveSessionResponsestruct to encapsulate different types of messages from the live session. - Introduced the
ILiveSessionMessageinterface and implementing structs:LiveSessionContent,LiveSessionToolCall, andLiveSessionToolCallCancellation. - Added logic to parse different message types from JSON responses.
- Added properties to extract text and audio content from
LiveSessionContent.
- Created a new
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
A struct's refactor,
Fields move, no longer factor,
Interface aligns.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request refactors the LiveSession responses, renaming the top-level struct and moving fields into other structs with a shared interface. The changes seem well-structured and improve the organization of the response handling. However, there are a few areas that could be improved for clarity and completeness.
Summary of Findings
- Missing
FunctionIdsToCancelimplementation: The originalLiveContentResponsestruct had aTODOcomment forFunctionIdsToCancel. This functionality seems to be missing in the refactoredLiveSessionToolCallCancellationstruct. It's important to ensure this feature is implemented or explicitly removed if it's no longer needed. - Incomplete
serverContentparsing: TheLiveSessionResponse.FromJsonmethod has aTODOcomment indicating that other fields withinserverContentneed to be parsed. This should be addressed to ensure all relevant data is being processed. - Potential
NullReferenceExceptioninAudioproperty: TheAudioproperty inLiveSessionResponsereturnsnullifMessageis not aLiveSessionContent. This could lead to aNullReferenceExceptionif the caller attempts to access theAudioproperty without checking ifMessageis of the correct type.
Merge Readiness
The refactoring improves the structure of the LiveSession responses. However, the missing FunctionIdsToCancel implementation, incomplete serverContent parsing, and potential NullReferenceException in the Audio property should be addressed before merging. I am unable to approve this pull request, and recommend that it not be merged until these issues are resolved. Please have others review and approve this code before merging.
| .Where(part => part.MimeType == "audio/pcm") | ||
| .Select(part => part.Data.ToArray()); | ||
| } | ||
| return null; |
There was a problem hiding this comment.
Returning null here could lead to a NullReferenceException if the caller attempts to access the Audio property without checking if Message is of the correct type. Consider returning an empty IEnumerable<byte[]> instead.
return Enumerable.Empty<byte[]>();| // We don't want to pass this along to the user, so return null instead. | ||
| return null; | ||
| } else if (jsonDict.TryParseValue("serverContent", out Dictionary<string, object> serverContent)) { | ||
| // TODO: Other fields |
There was a problem hiding this comment.
This TODO indicates that there are other fields within serverContent that need to be parsed. Ensure that all relevant data is being processed.
// TODO: Other fields
// Parse other fields from serverContent here| } else if (jsonDict.TryParseValue("toolCallCancellation", out Dictionary<string, object> toolCallCancellation)) { | ||
| return new LiveSessionResponse(LiveSessionToolCallCancellation.FromJson(toolCallCancellation)); | ||
| } else { | ||
| // TODO: Determine if we want to log this, or just ignore it? |
There was a problem hiding this comment.
This TODO indicates a decision needs to be made about logging or ignoring parsing failures. Determine the appropriate behavior and implement it.
// TODO: Determine if we want to log this, or just ignore it?
// Implement logging or ignoring behavior here
Description
Refactor how the LiveSession responses are handled. Rename the top level struct from LiveContentResponse to LiveSessionResponse, move the various fields into other structs that use a shared interface that LiveContentResponse now contains instead.
Testing
Running locally.
Type of Change
Place an
xthe applicable box: